eFAWATEERcom BANK API

(0 reviews)

Postpaid Bill Inquiry

URLs :

Environment	Method	URL
Mock	POST	https://eu1.anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/4be2e19f-42da-4571-80fd-19077a31ce58/efawateercom-bank-exp-api/1.0.7/m/postpaid/bill-inquiry
Dev	POST	https://maictrldev.capitalbank.jo/efawateercom-bank-api/v1/postpaid/bill-inquiry
Stage	POST	https://maictrlstg.capitalbank.jo/efawateercom-bank-api/v1/postpaid/bill-inquiry
Prod	POST	To be updated

Description : This service allows the channel to make inquiries on customer Bill and return the payment information.

Channels that want to know detailed information about a bill will pass the bill inquiry request to the mule service, mule service will in turn call the eFAWATEERcom endpoint, get the bill inquiry response and give that back to the channel. In between the request or response will not be stored in any layers within the mule. With this bill-inquiry endpoint channels can also fetch bill payment history and paid bills. eFAWATEERcom does not allow bulks for bill inquiry request.

Mulesoft Request:

Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id, client_secret

Optional Headers: x-sub-channel-id, x-user-id, Authorization, x-debug-flag, x-customer-id

Request Body: application/json

Field Name	Type	Length	Occurrence	Description
billInquiry	Object		M
acctInfo	Object		M
billingNo	string	50	M
billno	string	50	O
billerCode	Integer	3	M	Represents the unique code of the Biller
End of AcctInfo
serviceType	string	25	M
payerInfo	Object		M
idType	string	3	C
id	string	20	C
nation	Enum, char	2	C	Enum : JO Jordanian IQ Iraq GB British KW Kuwait
name	string	20	O
phone	string	20	O
address	string	100	O
email	string	100	O
joebppsNo	Integer	10	C
End of 'payerInfo'
dateRange	Object		O
startDt	DateTime		M
endDt	DateTime		M
End of ' dateRange '
incPayments	Boolean		O	Determines whether payment history is to be included in the inquiry response
incPaidBills	Boolean		O	Determines whether paid bills are to be included in the inquiry response
End of ' billInquiry '

Request Sample with Mandatory Elements:

{
"billInquiry": {
"acctInfo": {
"billingNo": "198111",
"billerCode": 39
},
"serviceType": "Electricity",
"payerInfo": {
"joebppsNo": 7045
}
}
}

Request Sample for fetching payments History

{
 "billInquiry": {
   "acctInfo": {
     "billingNo": "198111",
     "billerCode": 39
   },
   "serviceType": "Electricity",
   "payerInfo": {
     "joebppsNo": 7045
   },
   "incPayments": true
 }
}

Request Sample for fetching paid bills:

{
 "billInquiry": {
   "acctInfo": {
     "billingNo": "198111",
     "billerCode": 39
   },
   "serviceType": "Electricity",
   "payerInfo": {
     "joebppsNo": 7045
   },
   "incPaidBills": true
 }
}

Mulesoft Response:

Success Response: (200)

Response Body: application/json

Field Name	Type	Length	Occurrence	Description	Validation
status	Object		M
success	Boolean		M	true false
code	String	10	M	Error Code	“0” incase of success or Error Code
reasonCode	String	50	O	Error Type or Error category	Add this tag only incase of error
arabicMessage	String	200	M	English message translated to Arabic	تمت العملية بنجاح in case of success or arabic translated error in case of known errors
englishMessage	String	200	M	Description about the processing	“The Operation has been Successfully Completed” Or error Description
End of status
response	Object		O		Exists if success = true
billInquiry	Object		M
inqRefNo	Integer	20	O
recCount	Integer		M
billsRec	Object		C		Mandatory : if RecCount > 0
billRec	Array		M		Repeatable
result	Object		O
errorCode	Integer	5	M
errorDesc	String	20	M
severity	String	10	M
End of result
acctInfo	Object		M
billingNo	Integer	50	M
billno	string	50	M
billerCode	string	3	O
End of acctInfo
billStatus	Enum, String	20	M		Enum: BillNew, BillUpdated, BillPaid BillPartiallyPaid or BillOverPaid
dueAmount	Decimal	12,3	M
feesAmt	Decimal	12,3	M
issueDate	DateTime		M
openDate	DateTime		O
dueDate	DateTime		M
expiryDate	DateTime		O
closeDate	DateTime		O
serviceType	string	25	M
billType	string	13	O		Enum: Recurring OneOff
pmtConst	Object		O
allowPart	Boolean		M		The value in this element ‘false’ or ‘true’
lower	Decimal	12,3	M
upper	Decimal	12,3	M
End of pmtConst
billPmts	Object		O
billPmt	Array		M		Repeatable
joebppsTrx	Integer	20	M
bankCode	Integer	3	M
dueAmount	Decimal	12,3	M
paidAmt	Decimal	12,3	M
pmtStatus	String	15	M
processDate	DateTime		M
End of 'billPmt'
End of 'billPmts'
End of 'billRec'
End of 'billsRec'
End of 'billInquiry'
End of ‘ response ‘

{
"status": {
"success": true,
"code": "200",
"arabicMessage": "تمت العملية بنجاح",
"englishMessage": "The Operation has been Successfully Completed"
},
"response": {
"billInquiry": {
"recCount": 2,
"billsRec": {
"billRec": [
{
"result": {
"errorCode": 0,
"errorDesc": "Success",
"severity": "Info"
},
"acctInfo": {
"billingNo": 198111,
"billNo": 198111,
"billerCode": 39
},
"billStatus": "BillNew",
"dueAmount": 8,
"feesAmt": 0,
"issueDate": 20220216,
"dueDate": 20220216,
"serviceType": "Electricity",
"pmtConst": {
"allowPart": true,
"lower": 1,
"upper": 100
}
},
{
"result": {
"errorCode": 0,
"errorDesc": "Success",
"severity": "Info"
},
"acctInfo": {
"billingNo": 198111,
"billNo": 198111,
"billerCode": 39
},
"billStatus": "BillNew",
"dueAmount": 8,
"feesAmt": 0,
"issueDate": 20220216,
"dueDate": 20220216,
"serviceType": "Electricity",
"pmtConst": {
"allowPart": true,
"lower": 1,
"upper": 100
}
}
]
}
}
}
}

Sample Error Response:

Error codes :

400:

content-type: JSON

{
"success": false,
"code": "400",
"reasonCode": "Bad Request",
"arabicMessage": "اقتراح غير جي",
"englishMessage": "UnrecognizedServiceType"
}

Postpaid Bill Inquiry

Reviews